/*
 * ------------------------------------------------------------------------
 *
 *  Copyright by KNIME AG, Zurich, Switzerland
 *  Website: http://www.knime.com; Email: contact@knime.com
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License, Version 3, as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, see <http://www.gnu.org/licenses>.
 *
 *  Additional permission under GNU GPL version 3 section 7:
 *
 *  KNIME interoperates with ECLIPSE solely via ECLIPSE's plug-in APIs.
 *  Hence, KNIME and ECLIPSE are both independent programs and are not
 *  derived from each other. Should, however, the interpretation of the
 *  GNU GPL Version 3 ("License") under any applicable laws result in
 *  KNIME and ECLIPSE being a combined program, KNIME AG herewith grants
 *  you the additional permission to use and propagate KNIME together with
 *  ECLIPSE with only the license terms in place for ECLIPSE applying to
 *  ECLIPSE and the GNU GPL Version 3 applying for KNIME, provided the
 *  license terms of ECLIPSE themselves allow for the respective use and
 *  propagation of ECLIPSE together with KNIME.
 *
 *  Additional permission relating to nodes for KNIME that extend the Node
 *  Extension (and in particular that are based on subclasses of NodeModel,
 *  NodeDialog, and NodeView) and that only interoperate with KNIME through
 *  standard APIs ("Nodes"):
 *  Nodes are deemed to be separate and independent programs and to not be
 *  covered works.  Notwithstanding anything to the contrary in the
 *  License, the License does not apply to Nodes, you are not required to
 *  license Nodes under the License, and you are granted a license to
 *  prepare and propagate Nodes, in each case even if such Nodes are
 *  propagated with or for interoperation with KNIME.  The owner of a Node
 *  may freely choose the license terms applicable to such Node, including
 *  when such Node is propagated with or for interoperation with KNIME.
 * ---------------------------------------------------------------------
 *
 * History
 *   22.08.2014 (koetter): created
 */
package org.knime.base.node.io.database.groupby.dialog;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;

import javax.swing.JComponent;
import javax.swing.JEditorPane;
import javax.swing.JScrollPane;
import javax.swing.ScrollPaneConstants;

import org.apache.commons.lang.StringEscapeUtils;
import org.knime.core.data.DataType;
import org.knime.core.node.port.database.DatabaseUtility;
import org.knime.core.node.port.database.aggregation.AggregationFunctionProvider;
import org.knime.core.node.port.database.aggregation.DBAggregationFunction;
import org.knime.core.node.port.database.aggregation.DBAggregationFunctionLabelComparator;

/**
 *
 * @author Tobias Koetter, KNIME AG, Zurich, Switzerland
 * @since 2.11
 */
@Deprecated
public class DBAggregationFunctionProvider implements AggregationFunctionProvider<DBAggregationFunction> {

    private final DatabaseUtility m_utility;

    /**
     * @param utility {@link DatabaseUtility}
     */
    public DBAggregationFunctionProvider(final DatabaseUtility utility) {
        m_utility = utility;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public List<DBAggregationFunction> getCompatibleFunctions(final DataType type, final boolean sorted) {
        final Collection<DBAggregationFunction> aggregationFunctions = m_utility.getAggregationFunctions();
        final List<DBAggregationFunction> compatible = new ArrayList<>(aggregationFunctions.size());
        for (DBAggregationFunction function : aggregationFunctions) {
            if (type == null || function.isCompatible(type)) {
                compatible.add(function);
            }
        }
        if (sorted) {
            Collections.sort(compatible, DBAggregationFunctionLabelComparator.ASC);
        }
        return compatible;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public DBAggregationFunction getFunction(final String id) {
        return m_utility.getAggregationFunction(id);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public DBAggregationFunction getDefaultFunction(final DataType type) {
        final Collection<DBAggregationFunction> aggregationFunctions = m_utility.getAggregationFunctions();
        for (DBAggregationFunction function : aggregationFunctions) {
            if (function.isCompatible(type)) {
                return function;
            }
        }
        return null;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public List<DBAggregationFunction> getFunctions(final boolean sorted) {
        return getCompatibleFunctions(null, sorted);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public JComponent getDescriptionPane() {
        final StringBuilder buf = getHTMLDescription();
        final JEditorPane editorPane = new JEditorPane("text/html", buf.toString());
        editorPane.setEditable(false);
        final JScrollPane scrollPane = new JScrollPane(editorPane, ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED,
                ScrollPaneConstants.HORIZONTAL_SCROLLBAR_AS_NEEDED);
        return scrollPane;
    }

    /**
     * @return the HTML String that lists all available aggregation methods
     * and their description as a definition list.
     */
    private StringBuilder getHTMLDescription() {
        final List<DBAggregationFunction> functions = getFunctions(true);
        final StringBuilder buf = new StringBuilder();
        buf.append("<dl>");
        buf.append("\n");
        for (final DBAggregationFunction function : functions) {
            buf.append("<dt><b>");
            buf.append(function.getLabel());
            buf.append("</b></dt>");
            buf.append("\n");
            buf.append("<dd>");
            buf.append(StringEscapeUtils.escapeHtml(function.getDescription()));
            buf.append("</dd>");
            buf.append("\n");
        }
        //close the last definition list
        buf.append("</dl>");
        return buf;
    }
}
